Changelog

All notable changes to this Kit will be documented in this file.

[X.X.X] - 2024-XX-XX

Changed

• Development View:
  • App Provider:
    • Replace use case specific FrameworkAgreement rightOperand with the new, consolidated DataExchangeGovernance released with 2408

[5.0.1] - 2024-05-22

Changed

• Development View:
  • App Provider:
    • Remove space before 'http' in namespaces (linter issue?)
    • Use 'Set' instead of 'Policy' because of EDC data management API
    • prefix UsagePurpose rightOperands with according value namespace "cx.core.*"
    • Remove version from cx-policy namespace (which used to be there in a very early draft only)
    • Update FrameworkAgreement rightOperand with upper case credential names as recently agreed and updated in Catena-X ODRL profile

[5.0.0] - 2024-05-06

Compatible for release 24.05.

Added

• Development View:
  • App Provider:
    • Created initial version for data consumer and app provider
    • Created optional quality notification API version 2.0.0

Changed

• Development View:
  • App Provider:
    • Changed mandatory quality notification API version 1.2.1 (- formerly 1.2.0 -)

Removed

• Development View:
  • Removed generated Notification API documentation (know directly available as Open API file)
  • Data Provider:
    • Removed aspects SingleLevelUsageAsPlanned and SingleLevelUsageAsBuilt, because these aspects moved to the Industry Core
    • (Re)moved policy section to the Industry Core KIT
  • App Provider:
    • Removed quality notification API version 1.1.0

[4.0.0] - 2024-02-28

Compatible for release 24.03.

Added

• Business View:
  • Additional information about quality notifications

Changed

• General:
  • Migrated content related to Industry Core to new Industry Core KIT
  • New Traceability KIT logo
• Business View:
  • Full rework with rewritten business descriptions
• Architecture View:
  • Notification state model updated
• Development View:
  • New Notification API version 1.2.0 (optional; version 1.1.0 mandatory)
  • Data Provider:
    • Usage Policies: Add more details and links about the framework agreement
    • Usage Policies: Add information for individual contracts between two companies as purpose-based policy

[3.0.0] - 2023-11-29

Compatible for release 23.12.

Added

• Architecture View:
  • Added assumptions and non-functional requirements for Traceability architecture
• Development View:
  • Data Provider:
    • Added a description of the purpose why assetLifecylePhase was added as specific asset ID

Changed

• General:
  • Restructure from adoption, operation and development view to business, architecture, operation and development view
  • License KIT to CC-BY-4.0
• Architecture View:
  • Update links to the latest versions of the Catena-X standards
• Development View:
  • Data Provider:
    • Updated aspect model SingleLevelBoMAsPlanned from version 1.1.0 to 2.0.0
    • Updated aspect model SingleLevelBomAsBuilt from version 1.0.0 to 2.0.0
    • Updated example for creation of the aspect model SingleLevelBomAsBuilt regarding version 2.0.0
    • Updated EDC asset props for unique ID push

[2.0.0] - 2023-09-28

Compatible for release 23.09 (also known as 3.2).

Added

• Adoption View:
  • TractionBatteryCode aspect model
  • Information about Verifiable Credentials
• Development View:
  • TractionBatteryCode aspect model

Changed

• General:
  • Updated all parts of the KIT related to the digital twin registry as the DTR now has a decentralized architecture
  • Updated SerialPartTypization 1.1.1 to SerialPart 1.0.1
  • Updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0
  • Updated aspect model Batch from version 1.0.2 to 2.0.0 (Release Notes)
  • Fixed references to deprecated releases
• Adoption View:
  • Updated description of the policy section (Access Policies, Usage Policies, Contract Definitions)
  • Updated relevant standards for release 3.2
• Development View:
  • Updated documentation because of the migration to the new standard AAS v3.0 by the DTR
  • Updated conventions for submodel descriptors and EDC asset structure to give data provides more flexibility in how to create EDC assets for submodels of digital twins
  • Setting the visibility of entries in a digital twin's specifid asset IDs is now mandatory to ensure need-know
  • Removed optional customer attributes from example for Batch aspect model
  • Updated purpose for Unique ID Push notifications to be compliant to the framework agreement for Traceability

Removed

• Adoption View:
  • Policy payloads are removed and replaced by specific documentation links

[1.0.1] - 2023-04-14

Compatible for release 3.1.

Added

• Adoption View:
  • Traceability tutorial video
  • Customer journey

[1.0.0] - 2023-04-12

Compatible for release 3.1.

Added

• Initial version of the Kit including adoption, operation and development view + two API specifications (Notification API, Unique ID Push API)

NOTICE

This work is licensed under the CC-BY-4.0.

• SPDX-License-Identifier: CC-BY-4.0
• SPDX-FileCopyrightText: 2023 BASF SE
• SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
• SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
• SPDX-FileCopyrightText: 2023 German Edge Cloud GmbH & Co. KG
• SPDX-FileCopyrightText: 2023 Mercedes Benz AG
• SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH
• SPDX-FileCopyrightText: 2023 SAP SE
• SPDX-FileCopyrightText: 2023 Siemens AG
• SPDX-FileCopyrightText: 2023 T-Systems International GmbH
• SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG
• SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
• Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version)